.TH "CvImageCapture" 3 "13 Oct 2009" "Version 2" "zebulon" \" -*- nroff -*-
.ad l
.nh
.SH NAME
CvImageCapture \- 
.PP
\fBVideo\fP Capture interface that supports USB/Firewire DV cameras and video files.  

.SH SYNOPSIS
.br
.PP
.PP
\fC#include <cvimagecapture.h>\fP
.SS "Classes"

.in +1c
.ti -1c
.RI "class \fBImage\fP"
.br
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBCvImageCapture\fP ()"
.br
.RI "\fIConstructor. \fP"
.ti -1c
.RI "\fB~CvImageCapture\fP ()"
.br
.RI "\fIDestructor. \fP"
.ti -1c
.RI "int \fBStart\fP (const std::string &videoSource, const int width=0, const int height=0, const bool interlace=false, const bool useDefaultCaptureLib=true)"
.br
.RI "\fIUse this method to start capture from a video source. \fP"
.ti -1c
.RI "int \fBStop\fP ()"
.br
.RI "\fIStops video capture. \fP"
.ti -1c
.RI "int \fBGetFrame\fP (\fBCvImageCapture::Image\fP *dest, const bool block=false)"
.br
.RI "\fIUse this method to get the current frame from the camera/video source. \fP"
.ti -1c
.RI "bool \fBIsReady\fP () const "
.br
.in -1c
.SS "Static Public Member Functions"

.in +1c
.ti -1c
.RI "static unsigned int \fBScanForSources\fP (std::vector< std::string > &sources)"
.br
.RI "\fIThis method is used to scan for video devices on the system. \fP"
.ti -1c
.RI "static bool \fBDeInterlaceData\fP (unsigned char *src, unsigned char *dest, unsigned short width, unsigned short height)"
.br
.RI "\fIThis method is used to de-interlace an interlaced image using interpolation. \fP"
.ti -1c
.RI "static void \fBFlipChannels\fP (\fBImage\fP &image)"
.br
.in -1c
.SH "Detailed Description"
.PP 
\fBVideo\fP Capture interface that supports USB/Firewire DV cameras and video files. 

Required Libraries: Windows: DirectX 9 SDK, Windows Platform SDK (DirectShow) if compiling, otherwise just use the produced DLL as is. Linux: LibV4L 
.SH "Member Function Documentation"
.PP 
.SS "static bool CvImageCapture::DeInterlaceData (unsigned char * src, unsigned char * dest, unsigned short width, unsigned short height)\fC [inline, static]\fP"
.PP
This method is used to de-interlace an interlaced image using interpolation. \fBParameters:\fP
.RS 4
\fIsrc\fP Source image data [3 channels RGB]. 
.br
\fIdest\fP The resulting de-interlaced image (must be pre-allocated). 
.br
\fIwidth\fP \fBImage\fP width in pixels. 
.br
\fIheight\fP \fBImage\fP height in pixels.
.RE
.PP
\fBReturns:\fP
.RS 4
True on success, false on failure. 
.RE
.PP

.SS "int CvImageCapture::GetFrame (\fBCvImageCapture::Image\fP * dest, const bool block = \fCfalse\fP)"
.PP
Use this method to get the current frame from the camera/video source. \fBParameters:\fP
.RS 4
\fIPointer\fP to image structure to fill with current frame. 
.br
\fIblock\fP If true, this method will block until a new frame arrives otherwise it will fall through if a new frame isn't available.
.RE
.PP
\fBReturns:\fP
.RS 4
1 on success, 0 on failure. 
.RE
.PP

.SS "bool CvImageCapture::IsReady () const"\fBReturns:\fP
.RS 4
True if ready to capture image data, false otherwise. 
.RE
.PP

.SS "unsigned int CvImageCapture::ScanForSources (std::vector< std::string > & sources)\fC [static]\fP"
.PP
This method is used to scan for video devices on the system. \fBParameters:\fP
.RS 4
\fIsources\fP \fBVideo\fP sources on the computer.
.RE
.PP
\fBReturns:\fP
.RS 4
Number of sources detected. 
.RE
.PP

.SS "int CvImageCapture::Start (const std::string & videoSource, const int width = \fC0\fP, const int height = \fC0\fP, const bool interlace = \fCfalse\fP, const bool useDefaultCaptureLib = \fCtrue\fP)"
.PP
Use this method to start capture from a video source. \fBParameters:\fP
.RS 4
\fIvideoSource\fP Camera/Video source name or file path. Examples: '/dev/video0' or 'Logitech Pro 9000'. 
.br
\fIwidth\fP Desired image capture width. If set to 0, then the default settings for the camera are used (default value). 
.br
\fIheight\fP Desired image capture height. If set to 0 then the default settings for the camera are used (default value). 
.br
\fIinterlace\fP If the image data is interlaced, this flag will enable automatic de-interlacing. 
.br
\fIuseDefaultCaptureLib\fP If true, the default capture library wrapped by this class is used, otherwise an alternate. (e.g. libv4l in Linux).
.RE
.PP
\fBReturns:\fP
.RS 4
1 on success, 0 on failure.
.RE
.PP
\fBParameters:\fP
.RS 4
\fIvideoSource\fP Camera/Video source name or file path. Examples: '/dev/video0' or 'Logitech Pro 9000' or a number '0', '1' for the camera number. 
.br
\fIwidth\fP Desired image capture width. If set to 0, then the default settings for the camera are used (default value). 
.br
\fIheight\fP Desired image capture height. If set to 0 then the default settings for the camera are used (default value). 
.br
\fIinterlace\fP If the image data is interlaced, this flag will enable automatic de-interlacing. 
.br
\fIuseDefaultCaptureLib\fP If true, the default capture library wrapped by this class is used, otherwise an alternate. (e.g. libv4l in Linux).
.RE
.PP
\fBReturns:\fP
.RS 4
1 on success, 0 on failure. 
.RE
.PP

.SS "int CvImageCapture::Stop ()"
.PP
Stops video capture. \fBReturns:\fP
.RS 4
1 on succes, 0 on failure. 
.RE
.PP


.SH "Author"
.PP 
Generated automatically by Doxygen for zebulon from the source code.
